Add note to handle events as quickly as possible.#405
Add note to handle events as quickly as possible.#405tnull merged 1 commit intolightningdevkit:mainfrom
Conversation
G8XSU
force-pushed
the
events-hurry-up
branch
from
58e1ec2 to
62b0a2a
Compare
tnull
left a comment
tnull
left a comment
There was a problem hiding this comment.
Thanks!
Do you mind adding a paragraph on general operation/usage of Node in the doc comment of struct Node, which then should also explictly state that events need to be handled? Let me know if you prefer me writing it though, happy to it in a follow-up.
I am not sure of the extent of this "how to handle events in ldk-node" doc on top of |
| /// **Caution:** Users must handle events as quickly as possible to prevent a large event backlog, | ||
| /// which can increase the memory footprint of [`Node`]. |
There was a problem hiding this comment.
Consider styling the message:
/// <div class="warning">
///
/// Users must handle events as quickly as possible to prevent a large event backlog,
/// which can increase the memory footprint of [`Node`].
///
/// </div>
https://doc.rust-lang.org/rustdoc/how-to-write-documentation.html#adding-a-warning-block
There was a problem hiding this comment.
We currently don't do that everywhere else, so for now landed this PR as-is. But might be an improvement to consider in the future, which we'd then however want to apply globally across all docs.
No worries! |
3 participants
No description provided.